API

Procurement APIs

PUT procurement/credit-notes/{supplierCreditNoteId}

Update provided supplier credit note

HTTP method PUT
URI https://api.rambase.net/procurement/credit-notes/{supplierCreditNoteId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierCreditNoteId} Supplier credit note identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4463, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<SupplierCreditNote
SupplierCreditNote

This field is optional.

>
2
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

>{String}</SuppliersReference>
3
     <SuppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

This field is optional.

>{String}</SuppliersInvoiceNumber>
4
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
5
     <Currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>{String}</Currency>
6
     <IssueDate
IssueDate

Date when the document was issued.

This field is optional.

>{Date}</IssueDate>
7
     <ReceivedDate
ReceivedDate

Date when the document was received.

This field is optional.

>{Date}</ReceivedDate>
8
     <SuppliersPaymentReference
SuppliersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

This field is optional.

>{String}</SuppliersPaymentReference>
9
     <BuyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

This field is optional.

>{String}</BuyersReferenceNumber>
10
     <InvoiceAddressAttention
InvoiceAddressAttention

Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.

This field is optional.

>{String}</InvoiceAddressAttention>
11
     <AccountingPeriod
AccountingPeriod

This field is optional.

>
12
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

Minimum value: 199000

Maximum value: 299912

This field is optional.

>{Integer}</AccountingPeriodId>
13
     </AccountingPeriod>
14
     <Supplier
Supplier

This field is optional.

>
15
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

>{Integer}</SupplierId>
16
     </Supplier>
17
     <SupplierBankAccount
SupplierBankAccount

This field is optional.

>
18
          <SupplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

Minimum value: 1

This field is optional.

>{Integer}</SupplierBankAccountId>
19
     </SupplierBankAccount>
20
     <Location
Location

This field is optional.

>
21
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
22
     </Location>
23
     <ShipFrom
ShipFrom

This field is optional.

>
24
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
25
     </ShipFrom>
26
     <Assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

>
27
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
28
     </Assignee>
29
     <Payment
Payment

This field is optional.

>
30
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
31
          <DueDate
DueDate

Date the object is due to be paid

This field is optional.

>{Date}</DueDate>
32
     </Payment>
33
     <Totals
Totals

This field is optional.

>
34
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

>{Decimal}</FreightAmount>
35
          <FeeAmount
FeeAmount

Fee amount in transaction document's currency

Minimum value: 0

This field is optional.

>{Decimal}</FeeAmount>
36
          <RoundOffAmount
RoundOffAmount

Round-off amount in transaction document's currency

This field is optional.

>{Decimal}</RoundOffAmount>
37
          <VATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in transaction document's currency

This field is optional.

>{Decimal}</VATRoundOffAmount>
38
     </Totals>
39
     <VATDetails
VATDetails

This field is optional.

>
40
          <PostponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

This field is optional.

>{Boolean}</PostponeVAT>
41
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

>{String}</VATHandling>
42
          <VATRate
VATRate

Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.

This field is optional.

>{Decimal}</VATRate>
43
          <VATDate
VATDate

Date of VAT posting. Currency rate calculation use this date.

This field is optional.

>{Date}</VATDate>
44
          <VATPeriod
VATPeriod

Accounting period this VAT posting belongs to

Minimum value: 199000

Maximum value: 299912

This field is optional.

>{Integer}</VATPeriod>
45
     </VATDetails>
46
     <PolishRequirements
PolishRequirements

This field is optional.

>
47
          <PurchaseOutsideEU
PurchaseOutsideEU

Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".

This field is optional.

>{Boolean}</PurchaseOutsideEU>
48
     </PolishRequirements>
49
</SupplierCreditNote>
1
{
2
     "supplierCreditNote
SupplierCreditNote

This field is optional.

": {
3
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

": "{String}",
4
          "suppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

This field is optional.

": "{String}",
5
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

": "{String}",
6
          "currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "issueDate
IssueDate

Date when the document was issued.

This field is optional.

": "{Date}",
8
          "receivedDate
ReceivedDate

Date when the document was received.

This field is optional.

": "{Date}",
9
          "suppliersPaymentReference
SuppliersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

This field is optional.

": "{String}",
10
          "buyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

This field is optional.

": "{String}",
11
          "invoiceAddressAttention
InvoiceAddressAttention

Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.

This field is optional.

": "{String}",
12
          "accountingPeriod
AccountingPeriod

This field is optional.

": {
13
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

Minimum value: 199000

Maximum value: 299912

This field is optional.

": "{Integer}"
14
          },
15
          "supplier
Supplier

This field is optional.

": {
16
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

": "{Integer}"
17
          },
18
          "supplierBankAccount
SupplierBankAccount

This field is optional.

": {
19
               "supplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

Minimum value: 1

This field is optional.

": "{Integer}"
20
          },
21
          "location
Location

This field is optional.

": {
22
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
23
          },
24
          "shipFrom
ShipFrom

This field is optional.

": {
25
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
26
          },
27
          "assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

": {
28
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
29
          },
30
          "payment
Payment

This field is optional.

": {
31
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Applicable domain values can be found here

This field is optional.

": "{String}",
32
               "dueDate
DueDate

Date the object is due to be paid

This field is optional.

": "{Date}"
33
          },
34
          "totals
Totals

This field is optional.

": {
35
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

": "{Decimal}",
36
               "feeAmount
FeeAmount

Fee amount in transaction document's currency

Minimum value: 0

This field is optional.

": "{Decimal}",
37
               "roundOffAmount
RoundOffAmount

Round-off amount in transaction document's currency

This field is optional.

": "{Decimal}",
38
               "vATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in transaction document's currency

This field is optional.

": "{Decimal}"
39
          },
40
          "vATDetails
VATDetails

This field is optional.

": {
41
               "postponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

This field is optional.

": "{Boolean}",
42
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

": "{String}",
43
               "vATRate
VATRate

Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.

This field is optional.

": "{Decimal}",
44
               "vATDate
VATDate

Date of VAT posting. Currency rate calculation use this date.

This field is optional.

": "{Date}",
45
               "vATPeriod
VATPeriod

Accounting period this VAT posting belongs to

Minimum value: 199000

Maximum value: 299912

This field is optional.

": "{Integer}"
46
          },
47
          "polishRequirements
PolishRequirements

This field is optional.

": {
48
               "purchaseOutsideEU
PurchaseOutsideEU

Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".

This field is optional.

": "{Boolean}"
49
          }
50
     }
51
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102232 HTTP 400 Missing mandatory parameter Loc
Error 100199 HTTP 404 Location not found
Error 102229 HTTP 400 Location {0} is already defined on the product
Error 101488 HTTP 400 Illegal general ledger account : {0}
Error 105186 HTTP 400 Postings are not allowed on control accounts.
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}